Vcenter Vm Hardware Ethernet BackingInfo

The Vcenter Vm Hardware Ethernet BackingInfo schema contains information about the physical resource backing a virtual Ethernet adapter.

JSON Example

{
    "type": "string",
    "network": "string",
    "network_name": "string",
    "host_device": "string",
    "distributed_switch_uuid": "string",
    "distributed_port": "string",
    "connection_cookie": 0,
    "opaque_network_type": "string",
    "opaque_network_id": "string"
}

string

type

Required

Backing type for the virtual Ethernet adapter.

For more information see: Vcenter Vm Hardware Ethernet BackingType.

string

network

Optional

Identifier of the network backing the virtual Ethernet adapter.

If missing or null, the identifier of the network backing could not be determined.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network.

string

network_name

Optional

Name of the standard portgroup backing the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet BackingType.STANDARD_PORTGROUP.

string

host_device

Optional

Name of the device backing the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet BackingType.HOST_DEVICE.

string

distributed_switch_uuid

Optional

UUID of the distributed virtual switch that backs the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet BackingType.DISTRIBUTED_PORTGROUP.

string

distributed_port

Optional

Key of the distributed virtual port that backs the virtual Ethernet adapter.

This property will be missing or null if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

integer As int64 As int64

connection_cookie

Optional

Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port.

string

opaque_network_type

Optional

Type of the opaque network that backs the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet BackingType.OPAQUE_NETWORK.

string

opaque_network_id

Optional

Identifier of the opaque network that backs the virtual Ethernet adapter.

This property is optional and it is only relevant when the value of type is Vcenter Vm Hardware Ethernet BackingType.OPAQUE_NETWORK.